home *** CD-ROM | disk | FTP | other *** search
/ EuroCD 3 / EuroCD 3.iso / Programming / Python-1.4 / Demo / scripts / newslist.py < prev    next >
Text File  |  1998-06-24  |  11KB  |  366 lines
  1. #! /usr/local/bin/python
  2. #######################################################################
  3. # Newslist  $Revision: 1.7 $
  4. #
  5. # Syntax:
  6. #    newslist [ -a ]
  7. #
  8. # This is a program to create a directory full of HTML pages 
  9. # which between them contain links to all the newsgroups available
  10. # on your server.
  11. #
  12. # The -a option causes a complete list of all groups to be read from 
  13. # the server rather than just the ones which have appeared since last
  14. # execution. This recreates the local list from scratch. Use this on
  15. # the first invocation of the program, and from time to time thereafter.
  16. #   When new groups are first created they may appear on your server as 
  17. # empty groups. By default, empty groups are ignored by the -a option.
  18. # However, these new groups will not be created again, and so will not
  19. # appear in the server's list of 'new groups' at a later date. Hence it
  20. # won't appear until you do a '-a' after some articles have appeared.
  21. # 
  22. # I should really keep a list of ignored empty groups and re-check them
  23. # for articles on every run, but I haven't got around to it yet.
  24. #
  25. # This assumes an NNTP news feed.
  26. #
  27. # Feel free to copy, distribute and modify this code for 
  28. # non-commercial use. If you make any useful modifications, let me 
  29. # know!
  30. #
  31. # (c) Quentin Stafford-Fraser 1994
  32. # fraser@europarc.xerox.com                     qs101@cl.cam.ac.uk
  33. #                                                                     #
  34. #######################################################################
  35. import sys,nntplib, string, marshal, time, os, posix, string
  36.  
  37. #######################################################################
  38. # Check these variables before running!                               #
  39.  
  40. # Top directory.
  41. # Filenames which don't start with / are taken as being relative to this.
  42. topdir='/anfs/qsbigdisc/web/html/newspage'
  43.  
  44. # The name of your NNTP host
  45. # eg. 
  46. #    newshost = 'nntp-serv.cl.cam.ac.uk'
  47. # or use following to get the name from the NNTPSERVER environment 
  48. # variable:
  49. #    newshost = posix.environ['NNTPSERVER']
  50. newshost = 'nntp-serv.cl.cam.ac.uk'
  51.  
  52. # The filename for a local cache of the newsgroup list
  53. treefile = 'grouptree'
  54.  
  55. # The filename for descriptions of newsgroups
  56. # I found a suitable one at ftp.uu.net in /uunet-info/newgroups.gz
  57. # You can set this to '' if you don't wish to use one.
  58. descfile = 'newsgroups'
  59.  
  60. # The directory in which HTML pages should be created
  61. # eg.
  62. #   pagedir  = '/usr/local/lib/html/newspage'
  63. #   pagedir  = 'pages' 
  64. pagedir  = topdir
  65.  
  66. # The html prefix which will refer to this directory
  67. # eg. 
  68. #   httppref = '/newspage/', 
  69. # or leave blank for relative links between pages: (Recommended)
  70. #   httppref = ''
  71. httppref = ''
  72.  
  73. # The name of the 'root' news page in this directory. 
  74. # A .html suffix will be added.
  75. rootpage = 'root'
  76.  
  77. # Set skipempty to 0 if you wish to see links to empty groups as well.
  78. # Only affects the -a option.
  79. skipempty = 1
  80.  
  81. # pagelinkicon can contain html to put an icon after links to
  82. # further pages. This helps to make important links stand out.
  83. # Set to '' if not wanted, or '...' is quite a good one.
  84. pagelinkicon='... <img src="http://pelican.cl.cam.ac.uk/icons/page.xbm"> '
  85.  
  86. # ---------------------------------------------------------------------
  87. # Less important personal preferences:
  88.  
  89. # Sublistsize controls the maximum number of items the will appear as
  90. # an indented sub-list before the whole thing is moved onto a different
  91. # page. The smaller this is, the more pages you will have, but the 
  92. # shorter each will be.
  93. sublistsize = 4
  94.  
  95. # That should be all.                                                 #
  96. #######################################################################
  97.  
  98. for dir in os.curdir, os.environ['HOME']:
  99.     rcfile = os.path.join(dir, '.newslistrc.py')
  100.     if os.path.exists(rcfile):
  101.         print rcfile
  102.         execfile(rcfile)
  103.         break
  104.  
  105. from nntplib import NNTP
  106. from stat import *
  107.  
  108. rcsrev = '$Revision: 1.7 $'[11:15]
  109. desc = {}
  110.  
  111. # Make (possibly) relative filenames into absolute ones
  112. treefile = os.path.join(topdir,treefile)
  113. descfile = os.path.join(topdir,descfile)
  114. page = os.path.join(topdir,pagedir)
  115.  
  116. # First the bits for creating trees ---------------------------
  117.  
  118. # Addtotree creates/augments a tree from a list of group names
  119. def addtotree(tree, groups):
  120.    print 'Updating tree...'
  121.    for i in groups:
  122.     parts = string.splitfields(i,'.')
  123.     makeleaf(tree, parts)
  124.  
  125. # Makeleaf makes a leaf and the branch leading to it if necessary
  126. def makeleaf(tree,path):
  127.    j = path[0]
  128.    l = len(path)
  129.  
  130.    if not tree.has_key(j):
  131.       tree[j] = {}
  132.    if l == 1:
  133.       tree[j]['.'] = '.'
  134.    if l > 1:
  135.       makeleaf(tree[j],path[1:])
  136.  
  137. # Then the bits for outputting trees as pages ----------------    
  138.  
  139. # Createpage creates an HTML file named <root>.html containing links
  140. # to those groups beginning with <root>.
  141.  
  142. def createpage(root, tree, p):
  143.    filename = os.path.join(pagedir,root+'.html')
  144.    if root == rootpage:
  145.       detail = ''
  146.    else:
  147.       detail = ' under ' + root
  148.    f = open(filename,'w')
  149.    # f.write('Content-Type: text/html\n')
  150.    f.write('<TITLE>Newsgroups available' + detail + '</TITLE>\n')
  151.    f.write('<H1>Newsgroups available' + detail +'</H1>\n')
  152.    f.write('<A HREF="'+httppref+rootpage+'.html">Back to top level</A><P>\n')
  153.    printtree(f,tree,0,p)
  154.    f.write('<I>This page automatically created by \'newslist\' v. '+rcsrev+'.')
  155.    f.write(time.ctime(time.time()) + '</I><P>')
  156.    f.close()
  157.  
  158. # Printtree prints the groups as a bulleted list.  Groups with
  159. # more than <sublistsize> subgroups will be put on a separate page.
  160. # Other sets of subgroups are just indented.
  161.  
  162. def printtree(f, tree, indent, p):
  163.    global desc
  164.    l = len(tree)
  165.  
  166.    if l > sublistsize and indent>0:
  167.       # Create a new page and a link to it
  168.       f.write('<LI><B><A HREF="'+httppref+p[1:]+'.html">')
  169.       f.write(p[1:]+'.*')
  170.       f.write('</A></B>'+pagelinkicon+'\n')
  171.       createpage(p[1:], tree, p)
  172.       return
  173.  
  174.    kl = tree.keys()
  175.  
  176.    if l > 1:
  177.       kl.sort()
  178.       if indent > 0:
  179.      # Create a sub-list
  180.      f.write('<LI>'+p[1:]+'\n<UL>')
  181.       else:
  182.      # Create a main list
  183.      f.write('<UL>')
  184.       indent = indent + 1
  185.    
  186.    for i in kl:
  187.       if i == '.':
  188.      # Output a newsgroup
  189.      f.write('<LI><A HREF="news:' + p[1:] + '">'+ p[1:] + '</A> ')
  190.      if desc.has_key(p[1:]):
  191.         f.write('     <I>'+desc[p[1:]]+'</I>\n')
  192.      else:
  193.         f.write('\n')
  194.       else:
  195.      # Output a hierarchy
  196.      printtree(f,tree[i], indent, p+'.'+i)
  197.  
  198.    if l > 1:
  199.       f.write('\n</UL>')
  200.  
  201. # Reading descriptions file ---------------------------------------
  202.  
  203. # This returns an array mapping group name to its description
  204.  
  205. def readdesc(descfile):
  206.    global desc
  207.  
  208.    desc = {}
  209.  
  210.    if descfile == '':
  211.     return
  212.  
  213.    try:
  214.       d = open(descfile, 'r')
  215.       print 'Reading descriptions...'
  216.    except (IOError):
  217.       print 'Failed to open description file ' + descfile
  218.       return
  219.    l = d.readline()
  220.    while l != '':
  221.       bits = string.split(l)
  222.       try:
  223.      grp = bits[0]
  224.      dsc = string.join(bits[1:])
  225.      if len(dsc)>1:
  226.         desc[grp] = dsc
  227.       except (IndexError):
  228.      pass
  229.       l = d.readline()
  230.  
  231. # Check that ouput directory exists, ------------------------------
  232. # and offer to create it if not
  233.  
  234. def checkopdir(pagedir):
  235.    if not os.path.isdir(pagedir):
  236.       print 'Directory '+pagedir+' does not exist.'
  237.       print 'Shall I create it for you? (y/n)'
  238.       if sys.stdin.readline()[0] == 'y':
  239.      try:
  240.         os.mkdir(pagedir,0777)
  241.      except:
  242.         print 'Sorry - failed!'
  243.         sys.exit(1)
  244.       else:
  245.      print 'OK. Exiting.'
  246.      sys.exit(1)
  247.  
  248. # Read and write current local tree ----------------------------------
  249.  
  250. def readlocallist(treefile):
  251.       print 'Reading current local group list...'
  252.       tree = {}
  253.       try:
  254.      treetime = time.localtime(os.stat(treefile)[ST_MTIME])
  255.       except:
  256.      print '\n*** Failed to open local group cache '+treefile
  257.      print 'If this is the first time you have run newslist, then'
  258.      print 'use the -a option to create it.'
  259.      sys.exit(1)
  260.       treedate = '%02d%02d%02d' % (treetime[0] % 100 ,treetime[1], treetime[2])
  261.       try:
  262.      dump = open(treefile,'r')
  263.      tree = marshal.load(dump)
  264.      dump.close()
  265.       except (IOError):
  266.      print 'Cannot open local group list ' + treefile
  267.       return (tree, treedate)
  268.  
  269. def writelocallist(treefile, tree):
  270.    try:
  271.       dump = open(treefile,'w')
  272.       groups = marshal.dump(tree,dump)
  273.       dump.close()
  274.       print 'Saved list to '+treefile+'\n'
  275.    except:
  276.       print 'Sorry - failed to write to local group cache '+treefile
  277.       print 'Does it (or its directory) have the correct permissions?'
  278.       sys.exit(1)
  279.  
  280. # Return list of all groups on server -----------------------------
  281.  
  282. def getallgroups(server):
  283.    print 'Getting list of all groups...'
  284.    treedate='010101'
  285.    info = server.list()[1]
  286.    groups = []
  287.    print 'Processing...'
  288.    if skipempty:
  289.       print '\nIgnoring following empty groups:'
  290.    for i in info:
  291.       grpname = string.split(i[0])[0]
  292.       if skipempty and string.atoi(i[1]) < string.atoi(i[2]):
  293.      print grpname+' ',
  294.       else:
  295.      groups.append(grpname)
  296.    print '\n'
  297.    if skipempty:
  298.       print '(End of empty groups)'
  299.    return groups
  300.  
  301. # Return list of new groups on server -----------------------------
  302.  
  303. def getnewgroups(server, treedate):
  304.    print 'Getting list of new groups since start of '+treedate+'...',
  305.    info = server.newgroups(treedate,'000001')[1]
  306.    print 'got '+`len(info)`+'.'
  307.    print 'Processing...',
  308.    groups = []
  309.    for i in info:
  310.       grpname = string.split(i)[0]
  311.       groups.append(grpname)
  312.    print 'Done'
  313.    return groups
  314.  
  315. # Now the main program --------------------------------------------
  316.  
  317. def main():
  318.    global desc
  319.  
  320.    tree={}
  321.  
  322.    # Check that the output directory exists
  323.    checkopdir(pagedir);
  324.  
  325.    try:
  326.       print 'Connecting to '+newshost+'...'
  327.       if sys.version[0] == '0':
  328.      s = NNTP.init(newshost)
  329.       else:
  330.      s = NNTP(newshost)
  331.       connected = 1
  332.    except (nntplib.error_temp, nntplib.error_perm), x:
  333.       print 'Error connecting to host:', x
  334.       print 'I\'ll try to use just the local list.'
  335.       connected = 0
  336.  
  337.    # If -a is specified, read the full list of groups from server   
  338.    if connected and len(sys.argv) > 1 and sys.argv[1] == '-a':
  339.  
  340.      groups = getallgroups(s)
  341.  
  342.    # Otherwise just read the local file and then add
  343.    # groups created since local file last modified.
  344.    else:
  345.  
  346.       (tree, treedate) = readlocallist(treefile)
  347.       if connected:
  348.      groups = getnewgroups(s, treedate)
  349.       
  350.    if connected:
  351.       addtotree(tree, groups)
  352.       writelocallist(treefile,tree)
  353.  
  354.    # Read group descriptions
  355.    readdesc(descfile)
  356.  
  357.    print 'Creating pages...'
  358.    createpage(rootpage, tree, '')
  359.    print 'Done'
  360.  
  361.  
  362. main()
  363.  
  364. # That's all folks
  365. ######################################################################
  366.